-
Account Access Consents
- Create Account Access Consents
- Get Account Access Consents by ConsentId
- Update Account Access Consent Status by ConsentId
-
Accounts
-
Balances
-
Bank Accounts (Dynamic Endpoint)
-
Beneficiaries
-
Direct Debits
-
Domestic Future Dated Payment Consents
- Create Domestic Future Dated Payment Cancellation Consents
- Create Domestic Future Dated Payment Consents
- Get Domestic Future Dated Payment Cancellation Consents by ConsentId
- Get Domestic Future Dated Payment Consents by ConsentId
-
Domestic Future Dated Payments
- Create Domestic Future Dated Payments
- Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId
- Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId
- Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId
-
Domestic Payments
- Create Domestic Payments
- Get Domestic Payment details by DomesticPaymentId
- Get Domestic Payments by DomesticPaymentId
-
Domestic Payments Consents
- Create Domestic Payment Consents
- Get Domestic Payment Consents Funds Confirmation by ConsentId
- Get Domestic Payment Consents by ConsentId
-
Dynamic Resource Doc
-
Event Notification
-
File Payment Consents
- Create File Payment Consents
- Create File Payment Consents File by ConsentId
- Get File Payment Consents File by ConsentId
- Get File Payment Consents by ConsentId
-
File Payments
- Create File Payments
- Get File Payment Details by FilePaymentId
- Get File Payments Report File by FilePaymentId
- Get File Payments by FilePaymentId
-
Future Dated Payments
-
International Payment Consents
- Create International Payment Consents
- Get International Payment Consents Funds Confirmation by ConsentId
- Get International Payment Consents by ConsentId
-
International Payments
- Create International Payments
- Get International Payment Details by InternationalPaymentId
- Get International Payments by InternationalPaymentId
-
Offers
-
Parties
-
Standing Orders
-
Statements
- Get Accounts Statement Tranactions by AccountId and StatementId
- Get Accounts Statement by AccountId and StatementId
- Get Accounts Statements File by AccountId and StatementId
- Get Accounts Statements by AccountId
- Get Statements
-
Supplementary Account Info
-
Transactions
-
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
-
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
-
_D Entity1(gh.29.uk)
-
_Fish Port
-
_Foo Bar
-
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
-
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
-
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
-
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
-
_Odometer(gh.29.uk)
-
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
-
_Sustrans
-
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
-
_Test1
BAHRAIN-OBFv1.0.0 (135 APIs)
API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Create new Simon Covid
Create new Simon Covid.
Let's put Covid99 stuff here
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"SimonCovid"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"simon_covid":{
"simonCovidId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanCreateDynamicEntity_SystemSimonCovid
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0,
function_name: by dynamicEntity_createSimonCovid_, operation_id: OBPv4.0.0-dynamicEntity_createSimonCovid_
Tags: _Simon Covid, Dynamic-Entity, Dynamic,
Delete Simon Covid by id
Delete Simon Covid by id
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"SimonCovid"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"simon_covid":{
"simonCovidId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanDeleteDynamicEntity_SystemSimonCovid
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0,
function_name: by dynamicEntity_deleteSimonCovid_, operation_id: OBPv4.0.0-dynamicEntity_deleteSimonCovid_
Tags: _Simon Covid, Dynamic-Entity, Dynamic,
Get Simon Covid List
Get Simon Covid List.
Let's put Covid99 stuff here
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"SimonCovid"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Can do filter on the fields
e.g: /SimonCovid?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Typical Successful Response:
{
"simon_covid_list":[{
"simon_covid":{
"simonCovidId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"name":"James Brown",
"number":698761728
}
}]
}
Required Roles:
-
CanGetDynamicEntity_SystemSimonCovid
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0,
function_name: by dynamicEntity_getSimonCovidList_, operation_id: OBPv4.0.0-dynamicEntity_getSimonCovidList_
Tags: _Simon Covid, Dynamic-Entity, Dynamic,
Get Simon Covid by id
Get Simon Covid by id.
Let's put Covid99 stuff here
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"SimonCovid"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"simon_covid":{
"simonCovidId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanGetDynamicEntity_SystemSimonCovid
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0,
function_name: by dynamicEntity_getSingleSimonCovid_, operation_id: OBPv4.0.0-dynamicEntity_getSingleSimonCovid_
Tags: _Simon Covid, Dynamic-Entity, Dynamic,
Update Simon Covid
Update Simon Covid.
Let's put Covid99 stuff here
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"SimonCovid"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
Authentication is Mandatory
Typical Successful Response:
{
"simon_covid":{
"simonCovidId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanUpdateDynamicEntity_SystemSimonCovid
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0,
function_name: by dynamicEntity_updateSimonCovid_, operation_id: OBPv4.0.0-dynamicEntity_updateSimonCovid_
Tags: _Simon Covid, Dynamic-Entity, Dynamic,